[TASK-285] python docs and API reference #291
Conversation
|
@leekeiabstraction @luoyuxia PTAL 🙏 |
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the Fluss Python bindings, including a usage guide and a standalone API reference, addressing issue #285.
Changes:
- Added a Python Client Guide with end-to-end examples (connect/admin/write/read, PK tables, partitioned tables).
- Added a Python API Reference enumerating classes, methods, constants, and basic type mappings.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/python-client.md | New Python client guide with conceptual overview and usage examples for admin, writers, scanners, PK + partitioned tables. |
| docs/python-api-reference.md | New API reference page listing Python binding classes/methods/constants and data type mappings. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Addressed comments, fixed TableDecriptor to match rust |
leekeiabstraction
left a comment
leekeiabstraction
left a comment
There was a problem hiding this comment.
TY for the PR, left one comment
fresh-borzoni
force-pushed
the
python-docs
branch
from
9321103 to
fa4d032
Compare
|
@leekeiabstraction TY for checking, rebased |
luoyuxia
left a comment
luoyuxia
left a comment
There was a problem hiding this comment.
@fresh-borzoni Thanks for the pr. LGTM overall. Just left comments for document structure:
- move these docs to
binding/pythonsince it's mainly for python - rename
binding/python/READMEtoDEVELOPMENT.mdsince it's mainly focus on how to develop. We may renamepython-api-reference.mdorpython-client.mdto real readme?
|
@luoyuxia TY for the review. |
|
I cleaned up DEVELOPMENT.md as it had a lot of TODOs and stale stuff, should all be good now |
luoyuxia
left a comment
luoyuxia
left a comment
There was a problem hiding this comment.
@fresh-borzoni Thanks. LGTM!
3 participants
Summary
closes #285
Added docs and API reference for python bindings